Staff Management API
Get Staff Access Information
Request URL
POST /api/v1.0/invoke/open-ability/method/manager-commands
Request Parameter
| Parameter Name | Type | Location | Required | Description |
|---|---|---|---|---|
| Content-Type | String | Header | Yes | Content type, the value is application/json |
| Accept | String | Header | Yes | Accept, the value is application/json |
| Authorization | String | Header | Yes | Bearer authorization, access token |
| command | String | Body | Yes | Command name |
| id | String | Body | Yes | Command ID |
| param | Object<param> | Body | Yes | Command parameter |
param description
| Parameter Name | Type | Location | Required | Description |
|---|---|---|---|---|
| project_id | String | Body | Yes | Project ID |
| page_size | Integer | Body | Yes | Page size |
| page_index | Integer | Body | Yes | Page index |
Return Parameter
| Parameter Name | Type | Location | Description |
|---|---|---|---|
| Content-Type | String | Header | Content type, the value is application/json |
| success | Boolean | Body | Whether the request is successful or not? true: success false: failure |
| timestamp | Integer | Body | Timestamp |
| result | []Object<result> | Body | Return result |
result description
| Parameter Name | Type | Location | Description |
|---|---|---|---|
| staff_access_id | String | Body | Staff access ID |
| staff_access_name | String | Body | Staff access name |
| created_time | String | Body | Created time, UTC |
| faces | []Object<face> | Body | Face information |
| pin_codes | []Object<pin_code> | Body | PIN code information |
| rf_cards | []Object<rf_card> | Body | RF card information |
| access_groups | []Object<access_group> | Body | Access group information |
| floor_accesses | []Object<floor_access> | Body | Floor access information |
face description
| Parameter Name | Type | Location | Description |
|---|---|---|---|
| face_id | String | Body | Face ID |
pin_code description
| Parameter Name | Type | Location | Description |
|---|---|---|---|
| pin_code_id | String | Body | PIN code ID |
| number | String | Body | Number |
rf_card description
| Parameter Name | Type | Location | Description |
|---|---|---|---|
| rf_card_id | String | Body | RF card ID |
| number | String | Body | Number |
access_group description
| Parameter Name | Type | Location | Description |
|---|---|---|---|
| access_group_name | String | Body | Access group name |
floor_access description
| Parameter Name | Type | Location | Description |
|---|---|---|---|
| building_name | String | Body | Building name |
| floor_access | []String | Body | Floor access |
Request Example
POST /api/v1.0/invoke/open-ability/method/manager-commands
Content-Type: application/json
Accept: application/json
Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9
{
"command": "get_staff_access_list",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {
"page_size": 1,
"page_index": 1,
"project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5"
}
}
Success Return Example
Status Code: 200
Content-Type: application/json
{
"success": true,
"timestamp": 1724816274618,
"result": [
{
"staff_access_id": "sx9a621c1ae77040d697bd2134700f57e",
"staff_access_name": "test",
"created_time": "2024-02-19 17:02:23",
"faces": [
{
"face_id": "fbr2c4b070cc928496198944858b344fc"
}
],
"pin_codes": [
{
"pin_code_id": "pbr2c4b070cc928496198944858b344fc",
"number": "123456"
}
],
"rf_cards": [
{
"rf_card_id": "rbr2c4b070cc928496198944858b344fc",
"number": "123456"
}
],
"access_groups": [
{
"access_group_name": "test"
}
],
"floor_accesses": [
{
"building_name": "AB01",
"floor_access": [
"1",
"2"
]
}
]
}
]
}
Failure Return Example
Get Staff Access Information
Request URL
POST /api/v1.0/invoke/open-ability/method/manager-commands
Request Parameter
| Parameter Name | Type | Location | Required | Description |
|---|---|---|---|---|
| Content-Type | String | Header | Yes | Content type, the value is application/json |
| Accept | String | Header | Yes | Accept, the value is application/json |
| Authorization | String | Header | Yes | Bearer authorization, access token |
| command | String | Body | Yes | Command name |
| id | String | Body | Yes | Command ID |
| param | Object<param> | Body | Yes | Command parameter |
param description
| Parameter Name | Type | Location | Required | Description |
|---|---|---|---|---|
| project_id | String | Body | Yes | Project ID |
| staff_access_id | String | Body | Yes | Staff access ID |
Return Parameter
| Parameter Name | Type | Location | Description |
|---|---|---|---|
| Content-Type | String | Header | Content type, the value is application/json |
| success | Boolean | Body | Whether the request is successful or not? true: success false: failure |
| timestamp | Integer | Body | Timestamp |
| result | Object<result> | Body | Return result |
result description
| Parameter Name | Type | Location | Description |
|---|---|---|---|
| staff_access_name | String | Body | Staff access name |
| created_time | String | Body | Created time, UTC |
| faces | []Object<face> | Body | Face information |
| pin_codes | []Object<pin_code> | Body | PIN code information |
| rf_cards | []Object<rf_card> | Body | RF card information |
| access_groups | []Object<access_group> | Body | Access group information |
| floor_accesses | []Object<floor_access> | Body | Floor access information |
face description
| Parameter Name | Type | Location | Description |
|---|---|---|---|
| face_id | String | Body | Face ID |
pin_code description
| Parameter Name | Type | Location | Description |
|---|---|---|---|
| pin_code_id | String | Body | PIN code ID |
| number | String | Body | Number |
rf_card description
| Parameter Name | Type | Location | Description |
|---|---|---|---|
| rf_card_id | String | Body | RF card ID |
| number | String | Body | Number |
access_group description
| Parameter Name | Type | Location | Description |
|---|---|---|---|
| access_group_id | String | Body | Access group ID |
| access_group_name | String | Body | Access group name |
| access_group_type | String | Body | Access group type, system or customized |
floor_access description
| Parameter Name | Type | Location | Description |
|---|---|---|---|
| building_id | String | Body | Building ID |
| building_name | String | Body | Building name |
| floor_access | []String | Body | Floor access |
Request Example
POST /api/v1.0/invoke/open-ability/method/manager-commands
Content-Type: application/json
Accept: application/json
Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9
{
"command": "get_staff_access_info",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {
"staff_access_id": "sx9a621c1ae77040d697bd2134700f57e",
"project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5"
}
}
Success Return Example
Status Code: 200
Content-Type: application/json
{
"success": true,
"timestamp": 1724816274618,
"result": {
"staff_access_name": "test",
"created_time": "2024-02-19 17:02:23",
"faces": [
{
"face_id": "fbr2c4b070cc928496198944858b344fc"
}
],
"pin_codes": [
{
"pin_code_id": "pbr2c4b070cc928496198944858b344fc",
"number": "123456"
}
],
"rf_cards": [
{
"rf_card_id": "rbr2c4b070cc928496198944858b344fc",
"number": "123456"
}
],
"access_groups": [
{
"access_group_name": "test",
"access_group_id": "arbr2c4b070cc928496198944858b344f",
"access_group_type": "system"
}
],
"floor_accesses": [
{
"building_id": "b1a621c1ae77040d697bd2134700f57ee",
"building_name": "AB01",
"floor_access": [
"1",
"2"
]
}
]
}
}
Failure Return Example
Create Staff Access Information
Request URL
POST /api/v1.0/invoke/open-ability/method/manager-commands
Request Parameter
| Parameter Name | Type | Location | Required | Description |
|---|---|---|---|---|
| Content-Type | String | Header | Yes | Content type, the value is application/json |
| Accept | String | Header | Yes | Accept, the value is application/json |
| Authorization | String | Header | Yes | Bearer authorization, access token |
| command | String | Body | Yes | Command name |
| id | String | Body | Yes | Command ID |
| param | Object<param> | Body | Yes | Command parameter |
param description
| Parameter Name | Type | Location | Required | Description |
|---|---|---|---|---|
| project_id | String | Body | Yes | Project ID |
| staff_access_name | String | Body | Yes | Staff access name |
| faces | []Object<face> | Body | No | Face information |
| pin_codes | []Object<pin_code> | Body | No | PIN code information |
| rf_cards | []Object<rf_card> | Body | No | RF card information |
| access_groups | []Object<access_group> | Body | Yes | Access group information |
| floor_accesses | []Object<floor_access> | Body | No | Floor access information |
face description
| Parameter Name | Type | Location | Required | Description |
|---|---|---|---|---|
| face_picture_url | String | Body | Yes | Face picture URL |
pin_code description
| Parameter Name | Type | Location | Required | Description |
|---|---|---|---|---|
| number | String | Body | Yes | Number |
rf_card description
| Parameter Name | Type | Location | Required | Description |
|---|---|---|---|---|
| number | String | Body | Yes | Number |
access_group description
| Parameter Name | Type | Location | Required | Description |
|---|---|---|---|---|
| access_group_id | String | Body | Yes | Access group ID |
floor_access description
| Parameter Name | Type | Location | Required | Description |
|---|---|---|---|---|
| building_id | String | Body | Yes | Building ID |
| floor_access | []String | Body | Yes | Floor access |
Return Parameter
| Parameter Name | Type | Location | Description |
|---|---|---|---|
| Content-Type | String | Header | Content type, the value is application/json |
| success | Boolean | Body | Whether the request is successful or not? true: success false: failure |
| timestamp | Integer | Body | Timestamp |
| result | Object<result> | Body | Return result |
result description
| Parameter Name | Type | Location | Description |
|---|---|---|---|
| staff_access_id | String | Body | Staff access ID |
Request Example
POST /api/v1.0/invoke/open-ability/method/manager-commands
Content-Type: application/json
Accept: application/json
Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9
{
"command": "create_staff_access_info",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {
"project_id": "p31adc223cc4b3bedb6bd4742dedcfa52",
"staff_access_name": "test",
"faces": [
{
"face_picture_url": "https://akcs.akubela.com/test"
}
],
"pin_codes": [
{
"number": "123456"
}
],
"rf_cards": [
{
"number": "123456"
}
],
"access_groups": [
{
"access_group_id": "arbr2c4b070cc928496198944858b344f"
}
],
"floor_accesses": [
{
"building_id": "b1a621c1ae77040d697bd2134700f57ee",
"floor_access": [
"1",
"2"
]
}
]
}
}
Success Return Example
Status Code: 200
Content-Type: application/json
{
"success": true,
"timestamp": 1540869200562,
"result": {
"staff_access_id": "s2a621c1ae77040d697bd2134700f57ea"
}
}
Failure Return Example
Update Staff Access Information
Request URL
POST /api/v1.0/invoke/open-ability/method/manager-commands
Request Parameter
| Parameter Name | Type | Location | Required | Description |
|---|---|---|---|---|
| Content-Type | String | Header | Yes | Content type, the value is application/json |
| Accept | String | Header | Yes | Accept, the value is application/json |
| Authorization | String | Header | Yes | Bearer authorization, access token |
| command | String | Body | Yes | Command name |
| id | String | Body | Yes | Command ID |
| param | Object<param> | Body | Yes | Command parameter |
param description
| Parameter Name | Type | Location | Required | Description |
|---|---|---|---|---|
| project_id | String | Body | Yes | Project ID |
| staff_access_id | String | Body | Yes | Staff access ID |
| staff_access_name | String | Body | Yes | Staff access name |
| faces | []Object<face> | Body | No | Face information |
| pin_codes | []Object<pin_code> | Body | No | PIN code information |
| rf_cards | []Object<rf_card> | Body | No | RF card information |
| access_groups | []Object<access_group> | Body | Yes | Access group information |
| floor_accesses | []Object<floor_access> | Body | No | Floor access information |
face description
| Parameter Name | Type | Location | Required | Description |
|---|---|---|---|---|
| face_picture_url | String | Body | Yes | Face picture URL |
pin_code description
| Parameter Name | Type | Location | Required | Description |
|---|---|---|---|---|
| number | String | Body | Yes | Number |
rf_card description
| Parameter Name | Type | Location | Required | Description |
|---|---|---|---|---|
| number | String | Body | Yes | Number |
access_group description
| Parameter Name | Type | Location | Required | Description |
|---|---|---|---|---|
| access_group_id | String | Body | Yes | Access group ID |
floor_access description
| Parameter Name | Type | Location | Required | Description |
|---|---|---|---|---|
| building_id | String | Body | Yes | Building ID |
| floor_access | []String | Body | Yes | Floor access |
Return Parameter
| Parameter Name | Type | Location | Description |
|---|---|---|---|
| Content-Type | String | Header | Content type, the value is application/json |
| success | Boolean | Body | Whether the request is successful or not? true: success false: failure |
| timestamp | Integer | Body | Timestamp |
| result | Object | Body | Return result |
Request Example
POST /api/v1.0/invoke/open-ability/method/manager-commands
Content-Type: application/json
Accept: application/json
Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9
{
"command": "update_staff_access_info",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {
"project_id": "p31adc223cc4b3bedb6bd4742dedcfa52",
"staff_access_id": "s2a621c1ae77040d697bd2134700f57ea",
"staff_access_name": "test",
"faces": [
{
"face_picture_url": "https://akcs.akubela.com/test"
}
],
"pin_codes": [
{
"number": "123456"
}
],
"rf_cards": [
{
"number": "123456"
}
],
"access_groups": [
{
"access_group_id": "arbr2c4b070cc928496198944858b344f"
}
],
"floor_accesses": [
{
"building_id": "b1a621c1ae77040d697bd2134700f57ee",
"floor_access": [
"1",
"2"
]
}
]
}
}
Success Return Example
Status Code: 200
Content-Type: application/json
{
"success": true,
"timestamp": 1540869200562,
"result": {}
}
Failure Return Example
Delete Staff Access Information
Request URL
POST /api/v1.0/invoke/open-ability/method/manager-commands
Request Parameter
| Parameter Name | Type | Location | Required | Description |
|---|---|---|---|---|
| Content-Type | String | Header | Yes | Content type, the value is application/json |
| Accept | String | Header | Yes | Accept, the value is application/json |
| Authorization | String | Header | Yes | Bearer authorization, access token |
| command | String | Body | Yes | Command name |
| id | String | Body | Yes | Command ID |
| param | Object<param> | Body | Yes | Command parameter |
param description
| Parameter Name | Type | Location | Required | Description |
|---|---|---|---|---|
| project_id | String | Body | Yes | Project ID |
| staff_access_id | String | Body | Yes | Staff access ID |
Return Parameter
| Parameter Name | Type | Location | Description |
|---|---|---|---|
| Content-Type | String | Header | Content type, the value is application/json |
| success | Boolean | Body | Whether the request is successful or not? true: success false: failure |
| timestamp | Integer | Body | Timestamp |
| result | Object | Body | Return result |
Request Example
POST /api/v1.0/invoke/open-ability/method/manager-commands
Content-Type: application/json
Accept: application/json
Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9
{
"command": "delete_staff_access_info",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {
"project_id": "p31adc223cc4b3bedb6bd4742dedcfa52",
"staff_access_id": "srbr2c4b070cc928496198944858b344f"
}
}
Success Return Example
Status Code: 200
Content-Type: application/json
{
"success": true,
"timestamp": 1540869200562,
"result": {}
}
Failure Return Example
Batch Delete Staff Access Information
Request URL
POST /api/v1.0/invoke/open-ability/method/manager-commands
Request Parameter
| Parameter Name | Type | Location | Required | Description |
|---|---|---|---|---|
| Content-Type | String | Header | Yes | Content type, the value is application/json |
| Accept | String | Header | Yes | Accept, the value is application/json |
| Authorization | String | Header | Yes | Bearer authorization, access token |
| command | String | Body | Yes | Command name |
| id | String | Body | Yes | Command ID |
| param | Object<param> | Body | Yes | Command parameter |
param description
| Parameter Name | Type | Location | Required | Description |
|---|---|---|---|---|
| project_id | String | Body | Yes | Project ID |
| staff_accesses | []Object<staff_access> | Body | Yes | Staff access information |
staff_access description
| Parameter Name | Type | Location | Required | Description |
|---|---|---|---|---|
| staff_access_id | String | Body | Yes | Staff access ID |
Return Parameter
| Parameter Name | Type | Location | Description |
|---|---|---|---|
| Content-Type | String | Header | Content type, the value is application/json |
| success | Boolean | Body | Whether the request is successful or not? true: success false: failure |
| timestamp | Integer | Body | Timestamp |
| result | Object | Body | Return result |
Request Example
POST /api/v1.0/invoke/open-ability/method/manager-commands
Content-Type: application/json
Accept: application/json
Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9
{
"command": "batch_delete_staff_access_info",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {
"project_id": "p01adc223cc4b3bedb6bd4742dedcfa52",
"staff_accesses": [
{
"staff_access_id": "s8b5a73f8dd84abaa94dcs248be49b0d1"
}
]
}
}
Success Return Example
Status Code: 200
Content-Type: application/json
{
"success": true,
"timestamp": 1540869200562,
"result": {}
}
Failure Return Example
Import Staff Access Information
Request URL
POST /api/v1.0/invoke/open-ability/method/manager-commands
Request Parameter
| Parameter Name | Type | Location | Required | Description |
|---|---|---|---|---|
| Content-Type | String | Header | Yes | Content type, the value is application/json |
| Accept | String | Header | Yes | Accept, the value is application/json |
| Authorization | String | Header | Yes | Bearer authorization, access token |
| command | String | Body | Yes | Command name |
| id | String | Body | Yes | Command ID |
| param | Object<param> | Body | Yes | Command parameter |
param description
| Parameter Name | Type | Location | Required | Description |
|---|---|---|---|---|
| project_id | String | Body | Yes | Project ID |
| file_name | String | Body | Yes | File name |
| file_url | String | Body | Yes | File URL |
Return Parameter
| Parameter Name | Type | Location | Description |
|---|---|---|---|
| Content-Type | String | Header | Content type, the value is application/json |
| success | Boolean | Body | Whether the request is successful or not? true: success false: failure |
| timestamp | Integer | Body | Timestamp |
| result | Object<result> | Body | Return result |
result description
| Parameter Name | Type | Location | Description |
|---|---|---|---|
| task_id | String | Body | Task ID |
Request Example
POST /api/v1.0/invoke/open-ability/method/manager-commands
Content-Type: application/json
Accept: application/json
Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9
{
"command": "import_staff_access_info",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {
"project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5",
"file_name": "test",
"file_url": "https://test.akubela.com/test-staff"
}
}
Success Return Example
Status Code: 200
Content-Type: application/json
{
"success": true,
"timestamp": 1540869200562,
"result": {
"task_id": "tpr31adc223cc4b3bedb6bd4742dedcfa"
}
}